<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>LibCDS: /home/zsshen/Desktop/git-hub-code/C-Common-Data-Structures/include/map/ordered_map.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">LibCDS
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('ordered__map_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">ordered_map.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="ordered__map_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * @file ordered_map.h The ordered map.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;</div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#ifndef _ORDERED_MAP_H_</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define _ORDERED_MAP_H_</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#include &quot;../util.h&quot;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">/** OMapData is the data type for the container private information. */</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="ordered__map_8h.html#a9f4a5f5b5f37e63daa432caf3dde3dbd">   11</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>_OMapData <a class="code" href="ordered__map_8h.html#a9f4a5f5b5f37e63daa432caf3dde3dbd">OMapData</a>;</div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">/** The implementation for ordered map. */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="structOrderedMap.html">   14</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>_OrderedMap {<span class="comment"></span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">    /** The container private information */</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="structOrderedMap.html#a771ae83146e8e2963f35a9a3a397add4">   16</a></span>&#160;    <a class="code" href="ordered__map_8h.html#a9f4a5f5b5f37e63daa432caf3dde3dbd">OMapData</a> *<a class="code" href="structOrderedMap.html#a771ae83146e8e2963f35a9a3a397add4">pData</a>;</div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment">    /** Insert a key value pair into the map.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment">        @see OdrMapPut */</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="structOrderedMap.html#a8993cee6def6f4401fc55b305e52bf1e">   20</a></span>&#160;    int32_t (*put) (<span class="keyword">struct </span>_OrderedMap*, <a class="code" href="util_8h.html#a0f62df023942df493672150257c26348">Entry</a>, bool);</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment">    /** Retrieve the value corresponding to the designated key.</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment">        @see OdrMapGet */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="structOrderedMap.html#ab7793ca60aac9cab5749f894ad596003">   24</a></span>&#160;    int32_t (*<span class="keyword">get</span>) (<span class="keyword">struct </span>_OrderedMap*, <a class="code" href="util_8h.html#ab8673c57cfd615afd06cafefa9c2445e">Key</a>, <a class="code" href="util_8h.html#ad0d0cb99e46ebc1c0458843e19ae21bd">Value</a>*);</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">    /** Delete the key value pair corresponding to the designated key.</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment">        @see OdrMapRemove */</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="structOrderedMap.html#a061e60fbb4e317fd257db2f8442d181e">   28</a></span>&#160;    int32_t (*<span class="keyword">remove</span>) (<span class="keyword">struct </span>_OrderedMap*, <a class="code" href="util_8h.html#ab8673c57cfd615afd06cafefa9c2445e">Key</a>, bool);</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment">    /** Return the number of stored key value pairs.</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment">        @see OdrMapSize */</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="structOrderedMap.html#aedbe1efedcb3db33166f2cc46b8ee77d">   32</a></span>&#160;    int32_t (*size) (<span class="keyword">struct </span>_OrderedMap*);</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment">    /** Set the user defined key value pair comparison method.</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment">        @see OdrMapSetCompare */</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structOrderedMap.html#aabb2c35a8c8ad97bc0de5d2a3d73bbef">   36</a></span>&#160;    int32_t (*set_compare) (<span class="keyword">struct </span>_OrderedMap*, int32_t (*) (<a class="code" href="util_8h.html#a0f62df023942df493672150257c26348">Entry</a>, <a class="code" href="util_8h.html#a0f62df023942df493672150257c26348">Entry</a>));</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment">    /** Set the user defined key value pair clean method.</span></div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="comment">        @see OdrMapSetDestroy */</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structOrderedMap.html#a583eb1e240451f618ba1a362dd056134">   40</a></span>&#160;    int32_t (*set_destroy) (<span class="keyword">struct </span>_OrderedMap*, void (*) (<a class="code" href="util_8h.html#a0f62df023942df493672150257c26348">Entry</a>));</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;} <a class="code" href="structOrderedMap.html">OrderedMap</a>;</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="comment">/*===========================================================================*</span></div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment"> *             Definition for the exported member operations                 *</span></div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment"> *===========================================================================*/</span><span class="comment"></span></div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment"> * @brief The constructor for OrderedMap.</span></div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment"> * @param ppObj         The double pointer to the to be constructed map</span></div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="comment"> * @retval ERR_NOMEM    Insufficient memory for map construction</span></div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;int32_t <a class="code" href="ordered__map_8h.html#ac1581cadbe1e602e3041c761b643422b">OdrMapInit</a>(<a class="code" href="structOrderedMap.html">OrderedMap</a> **ppObj);</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment"> * @brief The destructor for OrderedMap.</span></div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment"> * If the knob is on, it also runs the resource clean method for all the items.</span></div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment"> * @param ppObj         The double pointer to the to be destructed map</span></div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment"> * @param bClean        The knob to clean item resource</span></div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="keywordtype">void</span> <a class="code" href="ordered__map_8h.html#a5639a5fd98e433881893d6e72c6c1fd8">OdrMapDeinit</a>(<a class="code" href="structOrderedMap.html">OrderedMap</a> **ppObj, <span class="keywordtype">bool</span> bClean);</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="comment"> * @brief Insert a key value pair into the map.</span></div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="comment"> * This function inserts a key value pair into the map. If the order of the</span></div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="comment"> * designated pair is the same with a certain one stored in the map, that pair</span></div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="comment"> * will be replaced. Also, if the knob is on, it runs the resource clean method</span></div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment"> * for the replaced pair.</span></div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment"> * @param self          The pointer to OrderedMap structure</span></div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="comment"> * @param ent           The pointer to the desiganted key value pair</span></div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment"> * @param bClean        The knob to clean item resource</span></div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment"> * @retval ERR_NOMEM    Insufficient memory for map extension</span></div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;int32_t <a class="code" href="ordered__map_8h.html#a2963c0b274b18502cc18921831aec53a">OdrMapPut</a>(<a class="code" href="structOrderedMap.html">OrderedMap</a> *<span class="keyword">self</span>, <a class="code" href="util_8h.html#a0f62df023942df493672150257c26348">Entry</a> ent, <span class="keywordtype">bool</span> bClean);</div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="comment"> * @brief Retrieve the value corresponding to the designated key.</span></div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment"> * This function retrieves the value corresponding to the designated key from</span></div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment"> * the map. If the key can be found, the value will be returned by the third</span></div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="comment"> * parameter. Otherwise, the error code in returned and the third parameter is</span></div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="comment"> * updated with NULL.</span></div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="comment"> * @param self          The pointer to OrderedMap structure</span></div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="comment"> * @param key           The designated key</span></div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;<span class="comment"> * @param pValue        The pointer to the returned value</span></div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="comment"> * @retval ERR_NODATA   No map entry can be found</span></div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;int32_t <a class="code" href="ordered__map_8h.html#a619a60d853dd6688a982e83e443814e1">OdrMapGet</a>(<a class="code" href="structOrderedMap.html">OrderedMap</a> *<span class="keyword">self</span>, <a class="code" href="util_8h.html#ab8673c57cfd615afd06cafefa9c2445e">Key</a> key, <a class="code" href="util_8h.html#ad0d0cb99e46ebc1c0458843e19ae21bd">Value</a> *pValue);</div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="comment"> * @brief Delete the key value pair corresponding to the designated key.</span></div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;<span class="comment"> * This function deletes the key value pair corresponding to the designated key.</span></div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;<span class="comment"> * If the knob is on, it also runs the resource clean method for the deleted pair.</span></div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;<span class="comment"> * @param self          The pointer to OrderedMap structure</span></div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="comment"> * @param key           The designated key</span></div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="comment"> * @param bClean        The knob to clean item resource</span></div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="comment"> * @retval ERR_NODATA   No map entry can be found</span></div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;int32_t <a class="code" href="ordered__map_8h.html#abd56c8934746ba953f44f288883c3969">OdrMapRemove</a>(<a class="code" href="structOrderedMap.html">OrderedMap</a> *<span class="keyword">self</span>, <a class="code" href="util_8h.html#ab8673c57cfd615afd06cafefa9c2445e">Key</a> key, <span class="keywordtype">bool</span> bClean);</div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<span class="comment"> * @brief Return the number of stored key value pairs.</span></div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="comment"> * @param self          The pointer to OrderedMap structure</span></div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="comment"> * @return              The number of stored pairs</span></div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;int32_t <a class="code" href="ordered__map_8h.html#a9a9125dcdae60f2c676b2240b20a0e66">OdrMapSize</a>(<a class="code" href="structOrderedMap.html">OrderedMap</a> *<span class="keyword">self</span>);</div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="comment"> * @brief Set the user defined key value pair comparison method.</span></div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="comment"> * @param self          The pointer to OrderedMap structure</span></div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="comment"> * @param pFunc         The function pointer to the custom method</span></div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;int32_t <a class="code" href="ordered__map_8h.html#a1221dca5f047d70e2279760378402418">OdrMapSetCompare</a>(<a class="code" href="structOrderedMap.html">OrderedMap</a> *<span class="keyword">self</span>, int32_t (*pFunc) (<a class="code" href="util_8h.html#a0f62df023942df493672150257c26348">Entry</a>, <a class="code" href="util_8h.html#a0f62df023942df493672150257c26348">Entry</a>));</div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;<span class="comment"> * @brief Set the user defined key value pair clean method.</span></div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="comment"> * @param self          The pointer to OrderedMap structure</span></div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;<span class="comment"> * @param pFunc         The function pointer to the custom method</span></div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;int32_t <a class="code" href="ordered__map_8h.html#abe4c866e17b74263cea428ea554b984f">OdrMapSetDestroy</a>(<a class="code" href="structOrderedMap.html">OrderedMap</a> *<span class="keyword">self</span>, <span class="keywordtype">void</span> (*pFunc) (<a class="code" href="util_8h.html#a0f62df023942df493672150257c26348">Entry</a>));</div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;</div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="ordered__map_8h_html_a9a9125dcdae60f2c676b2240b20a0e66"><div class="ttname"><a href="ordered__map_8h.html#a9a9125dcdae60f2c676b2240b20a0e66">OdrMapSize</a></div><div class="ttdeci">int32_t OdrMapSize(OrderedMap *self)</div><div class="ttdoc">Return the number of stored key value pairs. </div></div>
<div class="ttc" id="util_8h_html_ad0d0cb99e46ebc1c0458843e19ae21bd"><div class="ttname"><a href="util_8h.html#ad0d0cb99e46ebc1c0458843e19ae21bd">Value</a></div><div class="ttdeci">const void * Value</div><div class="ttdoc">Value is the data type for the map-like element. </div><div class="ttdef"><b>Definition:</b> <a href="util_8h_source.html#l00036">util.h:36</a></div></div>
<div class="ttc" id="ordered__map_8h_html_a9f4a5f5b5f37e63daa432caf3dde3dbd"><div class="ttname"><a href="ordered__map_8h.html#a9f4a5f5b5f37e63daa432caf3dde3dbd">OMapData</a></div><div class="ttdeci">struct _OMapData OMapData</div><div class="ttdoc">OMapData is the data type for the container private information. </div><div class="ttdef"><b>Definition:</b> <a href="ordered__map_8h_source.html#l00011">ordered_map.h:11</a></div></div>
<div class="ttc" id="ordered__map_8h_html_a619a60d853dd6688a982e83e443814e1"><div class="ttname"><a href="ordered__map_8h.html#a619a60d853dd6688a982e83e443814e1">OdrMapGet</a></div><div class="ttdeci">int32_t OdrMapGet(OrderedMap *self, Key key, Value *pValue)</div><div class="ttdoc">Retrieve the value corresponding to the designated key. </div></div>
<div class="ttc" id="ordered__map_8h_html_a2963c0b274b18502cc18921831aec53a"><div class="ttname"><a href="ordered__map_8h.html#a2963c0b274b18502cc18921831aec53a">OdrMapPut</a></div><div class="ttdeci">int32_t OdrMapPut(OrderedMap *self, Entry ent, bool bClean)</div><div class="ttdoc">Insert a key value pair into the map. </div></div>
<div class="ttc" id="ordered__map_8h_html_abe4c866e17b74263cea428ea554b984f"><div class="ttname"><a href="ordered__map_8h.html#abe4c866e17b74263cea428ea554b984f">OdrMapSetDestroy</a></div><div class="ttdeci">int32_t OdrMapSetDestroy(OrderedMap *self, void(*pFunc)(Entry))</div><div class="ttdoc">Set the user defined key value pair clean method. </div></div>
<div class="ttc" id="ordered__map_8h_html_a5639a5fd98e433881893d6e72c6c1fd8"><div class="ttname"><a href="ordered__map_8h.html#a5639a5fd98e433881893d6e72c6c1fd8">OdrMapDeinit</a></div><div class="ttdeci">void OdrMapDeinit(OrderedMap **ppObj, bool bClean)</div><div class="ttdoc">The destructor for OrderedMap. </div></div>
<div class="ttc" id="ordered__map_8h_html_a1221dca5f047d70e2279760378402418"><div class="ttname"><a href="ordered__map_8h.html#a1221dca5f047d70e2279760378402418">OdrMapSetCompare</a></div><div class="ttdeci">int32_t OdrMapSetCompare(OrderedMap *self, int32_t(*pFunc)(Entry, Entry))</div><div class="ttdoc">Set the user defined key value pair comparison method. </div></div>
<div class="ttc" id="util_8h_html_a0f62df023942df493672150257c26348"><div class="ttname"><a href="util_8h.html#a0f62df023942df493672150257c26348">Entry</a></div><div class="ttdeci">const void * Entry</div><div class="ttdoc">Entry is the data type which wraps key value pair to manipulate map-like containers. </div><div class="ttdef"><b>Definition:</b> <a href="util_8h_source.html#l00040">util.h:40</a></div></div>
<div class="ttc" id="structOrderedMap_html_a771ae83146e8e2963f35a9a3a397add4"><div class="ttname"><a href="structOrderedMap.html#a771ae83146e8e2963f35a9a3a397add4">OrderedMap::pData</a></div><div class="ttdeci">OMapData * pData</div><div class="ttdoc">The container private information. </div><div class="ttdef"><b>Definition:</b> <a href="ordered__map_8h_source.html#l00016">ordered_map.h:16</a></div></div>
<div class="ttc" id="structOrderedMap_html"><div class="ttname"><a href="structOrderedMap.html">OrderedMap</a></div><div class="ttdoc">The implementation for ordered map. </div><div class="ttdef"><b>Definition:</b> <a href="ordered__map_8h_source.html#l00014">ordered_map.h:14</a></div></div>
<div class="ttc" id="ordered__map_8h_html_ac1581cadbe1e602e3041c761b643422b"><div class="ttname"><a href="ordered__map_8h.html#ac1581cadbe1e602e3041c761b643422b">OdrMapInit</a></div><div class="ttdeci">int32_t OdrMapInit(OrderedMap **ppObj)</div><div class="ttdoc">The constructor for OrderedMap. </div></div>
<div class="ttc" id="ordered__map_8h_html_abd56c8934746ba953f44f288883c3969"><div class="ttname"><a href="ordered__map_8h.html#abd56c8934746ba953f44f288883c3969">OdrMapRemove</a></div><div class="ttdeci">int32_t OdrMapRemove(OrderedMap *self, Key key, bool bClean)</div><div class="ttdoc">Delete the key value pair corresponding to the designated key. </div></div>
<div class="ttc" id="util_8h_html_ab8673c57cfd615afd06cafefa9c2445e"><div class="ttname"><a href="util_8h.html#ab8673c57cfd615afd06cafefa9c2445e">Key</a></div><div class="ttdeci">const void * Key</div><div class="ttdoc">Key is the data type to index map-like containers. </div><div class="ttdef"><b>Definition:</b> <a href="util_8h_source.html#l00033">util.h:33</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1e899e21dcf63412585e33a90ca7eaf3.html">map</a></li><li class="navelem"><a class="el" href="ordered__map_8h.html">ordered_map.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
  </ul>
</div>
</body>
</html>
